On this page you will get information about your first steps into the project.

  1. preparations & requirements : GFX, O/S, WiP status
  2. system setup : parameters for sauerbraten
  3. download walk-through : even if unused to sourceforge.net
  4. unpacking (where to)
  5. basic configuration : autoexec.cfg
  6. first run
  7. a look at SP
  8. a look at MP
  9. a look at RPG
  10. help yourself to some help - in case you have questions or problems

preparations/requirements

When you decide to try out Sauerbraten you should be aware of your operating system, your current graphics chipset (manufacturer and card name) and that this project is still "Work in Progress"!

Due to platform dependencies some stuff works differently depending on your O/S (operating system).
For example on linux users can dynamically change their screen resolution, on Win32 this isn't possible.

If you are running linux you should be sure that you have set up your system sufficiently to play,
running "glxgears -info" can help and having other OpenGL and/or SDL based applications already working is a solid basis to encourage you to proceed here.

Be prepared that some graphics cards have problems running with the default configuration.
You should then try to use all toggles to reduce rendering complexity and work yourself up.
Some example combinations:

system setup

First try running the game out-of-the-box,
but in the long run you will want to optimize your setup to your hardware and personal preferences.
There is a plethora of settings for you to do this.
RTFM : config page

To run with these parameters call your systems shell script with them.
Maybe you'd like to use some shell scripts to handle sauerbraten_unix for you,
switching between different setups made easy,
random start map selection.

@ECHO OFF
REM -- default call
REM bin\sauerbraten.exe -w1024 -h768 %1 %2 %3 %4 %5
REM -- full fledged call
REM bin\sauerbraten.exe -w1600 -h1200 -b24 -z24 -a4 -f3 %1 %2 %3 %4 %5
REM -- minimalistic call
REM bin\sauerbraten.exe -w800 -h600 -b8 -z16 -a0 -f -lpindakaas
REM -- my call
bin\sauerbraten.exe -w800 -h600 -b8 -z16 -a0 -f -lpindakaas
Later you might want to change the last line to your systems optimal settings.
It often pays to not have any settings in sauerbraten.bat itself.
Instead you could just call
bin\sauerbraten.exe %1 %2 %3 %4 %5
and add appropriate parameters to a range of links (*.lnk) - say on your Desktop -
like "Medium-Resolution Sauer", "minimal sauer", "EyeCandy", ...




download walk-through

Click on the appropriate download link and select your mirror to download the installation file.
Currently official clients exist for Win32, *Nix and OS X.
Pick a local mirror.

unpacking


basic configuration

Manage your configuration via the "autoexec.cfg".
If the file does not exist in your base installation folder then create it.
Two lines are a bare minimum:
name "GameName"
team "Team"

name is capped off at 15 characters, team at 4.

The autoexec.cfg is executed once upon start of the engine.
Then the engine looks for config.cfg and either executes this, if found, or recreates one from data/defaults.cfg.
This is important to know in case of the game suddenly being stubborn about something. The symptom usually is something like a keybinding (that used to work) no longer being functional - in such cases : quit the game, remove config.cfg (rename/delete) and restart the engine.

For a more complex setup you might like to try the meATpAk [0.6x], which gives you more elaborate menus, a keyboard layout switcher and loads of scripts to use as gamer, mapper or scripter.

first run

There are some external docs till this wiki contains those infos too :
Passa's (Win32) NewbieGuide
and
MeatROme's "Getting Started" Guide


a look at SP

The SinglePlayer (SP) modes of Sauerbraten enable you to play offline against a range of monsters.
Start your SP game via the menu or set your mode and an appropriate map by hand.
Beware that the so-called Episode 1 does not currently contain monsters. It is still WiP!
The single maps for basic SP (mode -2) do have monsters, though;
and you can play (almost) any map in DMSP (mode -1) against a horde of monsters matching your skill level.

In the basic SP mode (mode -2) which works more or less like in every other FPS -
you can pick up items only once and monsters stay killed;
progress is controlled with respawn-points.
Touching a respawn-point will set your next spawn to that location.
If you get fragged by the monsters you will respawn inside the map,
having lost all armour and some ammo, ...
...but at least your previous incarnation has cleared the way a little.
Your score is calculated as seconds you took to complete the map.
Deaths, monsters left, accuracy, and a basic modifier for skill setting all get taken into account.

The SP DeathMatch mode (DMSP (mode -1)) will work on any map - but some just won't cut it -
and will pit you against a number of monsters (10x skill) spawning at random points.
If you die in this mode the ordeal repeats - either you beat the horde or you don't - it's a DeathMatch!

a look at MP

The integrated server browser is available via the multiplayer menu, be sure to regularly update from master server.
The list is sorted by ping for your convenience.
A "P" next to the number of players indicates a private server and "L" stands for locked server.
(see mastermodes section)

a look at RPG

This is still very much WiP!
You can have a look at what's cooking by running with a -grpg parameter included.
So far only some NPC models are visible and the action menu is visible and ready for use,
only the actions simply output their name and don't really do anything yet. Stay tuned for further progress ...

help on finding help

While getting to know a new piece of software it is often the case that you might need help with an aspect you (personally) don't find intuitive.
This is perfectly natural and nothing to be ashamed of,
but the way you go about asking for help can be! So here's some help on getting help:
First off - as always - the hint to RTFM (read the fine manual), it seems impossible to stress this hard enough,
since we've had incredible amounts of requests for help by people who obviously didn't read the manual and could have saved everybody (including themselves) some time if they had.

Your local manual is accessible via the README.html in your installation folder;
the documentation is also available from sauerbraten.org.

The game is pretty straight-forward to jump into so some people seem to overlook the manual - don't make that mistake yourself!

Another suggestion is to read the following article about asking smart questions,
it's not associated with this project but is a general article about how to go about getting help on the interwebs.
Do not contact the authors about Cube/Sauerbraten/Eisenstern - they're only trying to help you find help (in general), not for this project specifically.


The next step for you would be to contact the community of this project;
either by posting in the cube forum
or by visiting the IRC-Channel #sauerbraten on irc.quakenet.org.

Good luck!